public class GxColumnFilterAG
implements GxFilterInterface
The class holds the shared ag filter options between all filter types. This is the base class for all ag filter types
| Modifier and Type | Field and Description |
|---|---|
BBjNumber | ApplyButton!Set to true to have the filter use an Apply button. If the Apply button is present, then the filter is only applied after the user hits the Apply button. |
BBjNumber | ClearButton!Set to true to have the filter use a Clear button. The Clear button will clear the details of the filter thus resetting it. |
BBjNumber | DebounceMs!The number of milliseconds to debounce by before applying the filter |
BBjString | DefaultOption!The default Filter Options to be selected. By default it is Equals |
JsonArray | FilterOptions!What Filter Options to present to the user. By default all supported options are presented |
BBjString | NewRowsAction!If set to 'clear', then setting data into the grid will clear (reset) the filter If set to 'keep' then the grid will keep it's currently set filter. The default is 'clear' |
BBjNumber | RestButton!Set to true to have the filter use a Reset button. The Reset button will clear the details of the filter and any active filters on that column. |
BBjNumber | SuppressAndOrCondition!If true, the filter will only offer Condition 1. |
| Modifier and Type | Method and Description |
|---|---|
boolean | equals(GxFilterInterface filter!)Compare two filters |
JsonObject | getAsJsonObject()Convert the filter definition to Json Object |
static BBjString | NEW_ROWS_ACTION_CLEAR()A constant which describes the NewRowsAction behavior |
static BBjString | NEW_ROWS_ACTION_KEEP()A constant which describes the NewRowsAction behavior |
public BBjNumber ApplyButton!Set to true to have the filter use an Apply button. If the Apply button is present, then the filter is only applied after the user hits the Apply button.
public BBjNumber ClearButton!Set to true to have the filter use a Clear button. The Clear button will clear the details of the filter thus resetting it.
public BBjNumber DebounceMs!The number of milliseconds to debounce by before applying the filter
public BBjString DefaultOption!The default Filter Options to be selected. By default it is Equals
public JsonArray FilterOptions!What Filter Options to present to the user. By default all supported options are presented
GxColumnFilterTextFilterOptions GxColumnFilterNumberFilterOptionspublic BBjString NewRowsAction!If set to 'clear', then setting data into the grid will clear (reset) the filter If set to 'keep' then the grid will keep it's currently set filter. The default is 'clear'
since version 1.7.0. This option has not replacement. The `keep` setting is now the default.public BBjNumber RestButton!Set to true to have the filter use a Reset button. The Reset button will clear the details of the filter and any active filters on that column.
public BBjNumber SuppressAndOrCondition!If true, the filter will only offer Condition 1.
public boolean equals(GxFilterInterface filter!)Compare two filters
filter! - Another filter instance to compare withpublic JsonObject getAsJsonObject()Convert the filter definition to Json Object
public static BBjString NEW_ROWS_ACTION_CLEAR()A constant which describes the NewRowsAction behavior
since version 1.7.0public static BBjString NEW_ROWS_ACTION_KEEP()A constant which describes the NewRowsAction behavior
since version 1.7.0